home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / misc / xref_v1.1.lha / XRef / Doc / english / parsexref.doc < prev    next >
Encoding:
Text File  |  1995-01-09  |  2.6 KB  |  75 lines
  1. XRef-Tools/ParseXRef                                       XRef-Tools/ParseXRef
  2.  
  3. $VER: parsexref.doc 1.6 (03.09.94)
  4.  
  5. NAME
  6.     ParseXRef - parse the specified xreffiles from xref.library and prints it
  7.                 to stdout
  8.  
  9. TEMPLATE
  10.     STRING/A,CATEGORY,FILE/K,LIMIT/K/N,FORMAT/K,NOPATTERN/S,NOCASE/S
  11.  
  12. FORMAT
  13.     ParseXRef [STRING] string [FILE xreffile] [[CATEGORY] category]
  14.               [LIMIT number] [FORMAT format-string] [NOPATTERN] [NOCASE]
  15.  
  16. FUNCTION
  17.     parses the specified xreffiles (CATEGORY or FILE argument) for a given
  18.     string/pattern. If no file or category is given it parses all xreffile,
  19.     which are actually loaded from the xref.library.If a category is specified
  20.     only such xreffiles are parsed, which match the category.If a file is
  21.     given only the file will parsed.If you turn the NOPATTERN switch on, the
  22.     string you passed via STRING argument is interpreted as a normal string
  23.     without any patternmatching tokens.It is passed to a normal string compare
  24.     function strcmp() or Stricmp(), otherwise to MatchPattern() or 
  25.     MatchPatternNoCase().Normally it is case-sensetive, but if you turn the
  26.     NOCASE switch on it isn't.
  27.  
  28. INPUTS
  29.     STRING (STRING) - string/pattern to parse for
  30.  
  31.     FILE (STRING) - file for the parse
  32.  
  33.     CATEGORY (STRING) - category for the parse (parse all files with this
  34.         category) . Can be a pattern !
  35.  
  36.     LIMIT (LONG) - maximal number of matching entries
  37.  
  38.     FORMAT (STRING) - format-string for the output to stdout following format
  39.         characters are supported after a '%' character :
  40.         %T - name of the XRefEntry type (e.g."AmigaGuide Node" or "struct" ..)
  41.         %P - global path for the entry
  42.         %F - file with a relative path for the entry
  43.         %N - name of the file
  44.         %X - XRefEntry name
  45.         %L - line number in the file for the XRefEntry
  46.         %G - AmigaGuide nodename
  47.         default template : "%T %X found !\nIn File : %F , Line : %L\n"
  48.  
  49.     NOPATTERN (BOOL) - indicates, that the entries are compares with strcmp
  50.         functions , instead of using MatchPattern()
  51.  
  52.     NOCASE (BOOL) - indicates, that case-insensetive compare should used
  53.  
  54. SEE ALSO
  55.     AGuideXRefV37, AGuideXRefV39, MakeXRef, LoadXRef, ExpungeXRef,
  56.     xref.library/ParseXRef(), dos.library/MatchPattern()
  57.  
  58. COPYRIGHT
  59.     (C) by Stefan Ruppert 1994
  60.  
  61. HISTORY
  62.     ParseXRef 1.6 (3.9.94) :
  63.         - changed some tag names
  64.  
  65.     ParseXRef 1.5 (6.7.94) :
  66.         - changed to new parsehook
  67.  
  68.     ParseXRef 1.4 (28.5.94) :
  69.         - output-template added
  70.  
  71.     ParseXRef 1.3 (18.5.94) :
  72.         - control-c support added
  73.         - first beta release
  74.  
  75.